add GitHub Actions workflow to build Antora documentation. #325
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spencer-lunarg
previously approved these changes
Jul 7, 2025
Contributor
spencer-lunarg
left a comment
spencer-lunarg
left a comment
There was a problem hiding this comment.
if github is happy, I am happy with this change
Contributor
Author
|
Okay, that should do it. |
Contributor
|
ok, this is good, but it actually should be failing I just realized the images show up in https://github.com/KhronosGroup/Vulkan-Guide/blob/main/chapters/image_copies.adoc but not in https://docs.vulkan.org/guide/latest/image_copies.html and looking at the CI run, I see the errors
|
Contributor
Author
|
Ahhh yes, I'll add a check when I get home
…On Mon, Jul 7, 2025, 6:22 PM Spencer Fricke ***@***.***> wrote:
*spencer-lunarg* left a comment (KhronosGroup/Vulkan-Guide#325)
<#325 (comment)>
ok, this is good, but it actually should be failing
I just realized the images show up in
https://github.com/KhronosGroup/Vulkan-Guide/blob/main/chapters/image_copies.adoc
but not in
https://docs.vulkan.org/guide/latest/image_copies.html
and looking at the CI run, I see the errors
image.png (view on web)
<https://github.com/user-attachments/assets/0640755e-40d7-4889-82f3-30d9f8a08e9b>
—
Reply to this email directly, view it on GitHub
<#325 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AA5IAYY2S527UHONBI5U32D3HMMM5AVCNFSM6AAAAACA7QALWCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTANBXGA2DCMRYGE>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
Contributor
|
aww, seems https://github.com/KhronosGroup/Vulkan-Guide/blob/main/antora/Makefile needs to be updated to cp .svg files as well diff --git a/antora/Makefile b/antora/Makefile
index b4e3f14..85b9640 100644
--- a/antora/Makefile
+++ b/antora/Makefile
@@ -23,6 +23,7 @@ setup_spec:
$(CP) $(wildcard chapters/extensions/[A-Za-z]*.adoc) $(ROOT)/pages/extensions/
mkdir -p $(ROOT)/images
$(CP) $(wildcard chapters/images/[A-Za-z]*.png) $(ROOT)/images/
+ $(CP) $(wildcard chapters/images/[A-Za-z]*.svg) $(ROOT)/images/
$(CP) $(wildcard images/[A-Za-z]*.png) $(ROOT)/images/
mkdir -p $(ROOT)/images/extensions
$(CP) $(wildcard chapters/images/extensions/[A-Za-z]*.png) $(ROOT)/images/extensionsbut this CI run should have "failed" and caught this |
Contributor
Author
|
Thanks for finding it. I'll do two steps one validate that it fails
correctly and two fix it then this PR is ready. But, I'm about two and
half hours from home. So won't be immediate
…On Mon, Jul 7, 2025, 6:31 PM Spencer Fricke ***@***.***> wrote:
*spencer-lunarg* left a comment (KhronosGroup/Vulkan-Guide#325)
<#325 (comment)>
aww, seems
https://github.com/KhronosGroup/Vulkan-Guide/blob/main/antora/Makefile
needs to be updated to cp .svg files as well
diff --git a/antora/Makefile b/antora/Makefile
index b4e3f14..85b9640 100644--- a/antora/Makefile+++ b/antora/Makefile@@ -23,6 +23,7 @@ setup_spec:
$(CP) $(wildcard chapters/extensions/[A-Za-z]*.adoc) $(ROOT)/pages/extensions/
mkdir -p $(ROOT)/images
$(CP) $(wildcard chapters/images/[A-Za-z]*.png) $(ROOT)/images/+ $(CP) $(wildcard chapters/images/[A-Za-z]*.svg) $(ROOT)/images/
$(CP) $(wildcard images/[A-Za-z]*.png) $(ROOT)/images/
mkdir -p $(ROOT)/images/extensions
$(CP) $(wildcard chapters/images/extensions/[A-Za-z]*.png) $(ROOT)/images/extensions
but this CI run should have "failed" and caught this
—
Reply to this email directly, view it on GitHub
<#325 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AA5IAY2VZVSAO7RIZBWSDHT3HMNQVAVCNFSM6AAAAACA7QALWCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTANBXGA2TOMRUGQ>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
…issues are logged properly.
…itional error patterns.
…warnings and errors.
…he images directory.
Contributor
Author
|
Okay, it will now error out on any warning or error produced by antora. I also fixed the errors themselves and it's a build passed. |
spencer-lunarg
approved these changes
Jul 8, 2025
Contributor
spencer-lunarg
left a comment
spencer-lunarg
left a comment
There was a problem hiding this comment.
@gpx1000 this is awesome!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm experimenting with having the CI create the antora playbook since it'd only be used by the CI of this project, no need for a file that checks it in.